Crate windows_strings

Windows string types

The windows-strings crate provides common Windows string types used by various Windows APIs.

• Getting started
• Samples
• Releases

Start by adding the following to your Cargo.toml file:

[dependencies.windows-strings]
version = "0.2"

Use the Windows string types as needed:

use windows_strings::*;

const A: PCSTR = s!("ansi");
const W: PCWSTR = w!("wide");

fn main() {
    let b = BSTR::from("bstr");
    let h = HSTRING::from("hstring");

    assert_eq!(b, "bstr");
    assert_eq!(h, "hstring");

    assert_eq!(unsafe { A.to_string().unwrap() }, "ansi");
    assert_eq!(unsafe { W.to_string().unwrap() }, "wide");
}

Macros

• h
  A literal HSTRING, length-prefixed wide string with a trailing null terminator.
• s
  A literal UTF-8 string with a trailing null terminator.
• w
  A literal UTF-16 wide string with a trailing null terminator.

Structs

• BSTR
  A BSTR string (BSTR) is a length-prefixed wide string.
• HSTRING
  An (HSTRING) is a reference-counted and immutable UTF-16 string type.
• HStringBuilder
  An HSTRING builder that supports preallocating the HSTRING to avoid extra allocations and copies.
• PCSTR
  A pointer to a constant null-terminated string of 8-bit Windows (ANSI) characters.
• PCWSTR
  A pointer to a constant null-terminated string of 16-bit Unicode characters.
• PSTR
  A pointer to a null-terminated string of 8-bit Windows (ANSI) characters.
• PWSTR
  A pointer to a null-terminated string of 16-bit Unicode characters.